Skip to content

Add some overview notes on the GADT implementation #14996

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 25, 2022

Conversation

dwijnand
Copy link
Member

Authored by Aleksander Boruch-Gruszecki.

The intent here is to start to have some more detailed information on
the implementation, even in an initially rough form that can be refined
over time.

@dwijnand dwijnand marked this pull request as ready for review April 21, 2022 09:23
@bishabosha
Copy link
Member

would you mind submitting this instead to the Scala 3 contribution guide, I would like to remove the internals docs at some point as they were copied and improved upon there.

@dwijnand
Copy link
Member Author

I kind of think contributing stuff should be in the repo, not outside. I can see the value of splitting out more general language documentation, helpful guides, examples, faqs and whatnot. But for things that are so closely related to internals and implementation I'd rather keep things close. For instance, if something starts as a piece of scaladoc or in-code comment, it could grow and want to become in markdown, perhaps to add a diagram or some clickable links - I don't think it should have to be exported to another repo. Similar to the desire to iterating on the capture checking docs or explicit null docs, which are WIP and not part of any release.

Copy link
Member

@bishabosha bishabosha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for putting the guide together all involved!

@bishabosha
Copy link
Member

actually, the sidebar still needs updating - https://github.com/lampepfl/dotty/blob/main/docs/sidebar.yml

Copy link
Member

@bishabosha bishabosha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that the sidebar config file should update as well

Authored by Aleksander Boruch-Gruszecki.

The intent here is to start to have some more detailed information on
the implementation, even in an initially rough form that can be refined
over time.
@dwijnand dwijnand merged commit ba8dccb into scala:main Apr 25, 2022
@dwijnand dwijnand deleted the gadts-notes branch May 3, 2022 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants